home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / Release-1.2.0rc2 < prev    next >
Text File  |  2004-03-24  |  14KB  |  311 lines
  1. $Id: Release-1.2.0rc2,v 1.19 2003/04/28 23:39:38 CelloG Exp $
  2.  
  3. PhpDocumentor Version 1.2.0 RELEASE CANDIDATE 2
  4. ################################################################################
  5. http://www.phpdoc.org
  6. Joshua Eichorn jeichorn@phpdoc.org
  7. Gregory Beaver cellog@users.sourceforge.net
  8. ################################################################################
  9. ################################################################################
  10.  
  11. The phpDocumentor team would like to announce the release of phpDocumentor
  12. 1.2.0 RELEASE CANDIDATE 2.  All features that will be present in the final
  13. release of 1.2.0 have been implemented, and all known bugs fixed.  This release
  14. is only intended to ensure that all bugs have been fixed before the big release.
  15.  
  16. The structure of the {@source} tag has changed slightly in this release.  See
  17. the documentation of inline {@source} for details
  18.  
  19. for PEAR users, the new --pear command-line switch will be a boon.  Leave it on
  20. by default if your package follows PEAR coding and directory naming standards
  21.  
  22. The peardoc2 converter has been moved to an extension of the DocBook converter,
  23. to use, the command-line has changed from XML:DocBook:peardoc2 to
  24. XML:DocBook/peardoc2:default.
  25.  
  26. ------
  27. IMPORTANT: phpDocumentor 1.2.0rc2 requires PHP version 4.1.0 or greater.
  28. phpDocumentor will function best with PHP version 4.3.0 or greater, as it will
  29. use of the tokenizer extension if php 4.3.0 is installed for a tremendous
  30. increase in parsing speed.
  31. ------
  32.  
  33. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  34. written in PHP.  It is the most versatile tool for documenting PHP.
  35.  
  36. Once again, phpDocumentor brings a great increase in usability with the 1.2
  37. branch.  The addition of a tokenizer-based parser increases parsing speed by
  38. up to 4 times (that's 400% faster) compared to previous versions.  In addition,
  39. scalability has been improved, allowing generation of documents in multiple
  40. output formats with one command.  The usage of config files makes repetitive
  41. parsing tasks straightforward and reduces the chance for error.
  42.  
  43. The addition of DocBlock templates, extended documentation (tutorials) parsing,
  44. and many other new features make this release the most useful automatic
  45. documentor for any programming language.
  46.  
  47. The default HTML Converter has been ported to a new Smarty-based converter,
  48. HTMLframesConverter, and all of the old templates have been ported to the new
  49. Smarty-based format.  The HTMLdefaultConverter has been deprecated since its
  50. functionality is redundant.  Due to the time it takes to convert a template to
  51. the new format, the phpDocumentor team extends an offer to do this conversion
  52. for anyone who has a brand new template.  We may also include the template in a
  53. future release, if permission is granted.
  54.  
  55. Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook
  56. converter with peardoc2 templates.  This converter could also generate other
  57. DocBook formats, if desired, but does not generate indexing for this release.
  58.  
  59. The PDF Converter has stepped up to beta-quality, is fully templatable, and
  60. has most bugs completely fixed.  The CHM converter has also taken major strides
  61. and is close to beta quality.
  62.  
  63. As predicted, the Smarty template engine is the primary template engine for
  64. all converters.
  65.  
  66. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  67. and intermediary data structures that allow it to perform at a level other
  68. automatic documentors for PHP cannot achieve:
  69.   --parsing any php file, with multiple classes and functions in the same file
  70.   --fully compliant with even the most esoteric php syntax 
  71.       ($string = <<< EOF, for example)
  72.   --ability to generate multiple output formats
  73.   --extremely fast parsing
  74.   --error/warnings by line number and file to allow for debugging of
  75.     documentation tags
  76.   --multiple output templates to easily customize the look of generated
  77.     documentation
  78.   --extensive documentation of the package, including a detailed specification
  79.     for tags and the included template engine
  80.   --open source, GPL
  81.   
  82.  
  83. A full listing of all closed bugs and feature requests can be found in the 
  84. next section of the notes
  85.  
  86. phpDocumentor 1.2.0rc2 is nearly ready for production use documenting any PHP
  87. project, download it and try the most advanced solution for PHP documentation
  88. today to help us find the last hidden bugs.
  89.  
  90. ################################################################################
  91.  
  92. The following bugs are fixed in version 1.2.0RC2
  93.  [ 708928 ] write permissions needed on some program dirs
  94.  [ 723230 ] warning on line 1391, HighlightParser
  95.  [ 723320 ] @param output behaves funny
  96.  [ 723767 ] space needed after @param type $var
  97.  [ 723947 ] RIC parsing not reading the correct README
  98.  [ 724415 ] Non-package references not always resolved
  99.  [ 724417 ] Multi-level method references not linked
  100.  [ 724701 ] conflicting package names, inherited links fails to show up
  101.  [ 724857 ] @link URL text broken
  102.  [ 725247 ] Wrong list handling in peardoc converter
  103.  [ 725745 ] HTML:Smarty:* not creating ric_README.html
  104.  [ 725161 ] File view displays class symbols without names
  105.  [ 725788 ] if --packageoutput excludes files with classes
  106.  [ 725742 ] code tag alignment
  107.  [ 726195 ] Formatting tags breaks lists
  108.  [ 726313 ] Changelog not linked
  109.  [ 727823 ] "#@+"-block quirck?
  110.  [ 728585 ] static keyword
  111.  [ 728167 ] HTML tags are case sensitive
  112.  
  113. The following bugs are fixed in version 1.2.0RC1
  114.  [ 566663 ] @param &$arg broken
  115.  [ 657041 ] {@source} doesn't work right
  116.  [ 675871 ] --pear breaks if not a pear repository
  117.  [ 678176 ] Inherited vars/methods in HTML:frames:phpedit
  118.  [ 680652 ] Optional method/function parameters
  119.  [ 681459 ] {@internal}} not quite working
  120.  [ 681463 ] {@source} drops characters
  121.  [ 681735 ] {@source} in sdesc needs warning
  122.  [ 682490 ] {@internal}} not parsed right by highlightparser
  123.  [ 682491 ] multi-line description fubared in @tag
  124.  [ 687091 ] special characters not encoded
  125.  [ 687364 ] highlightparser $class->member incorrect
  126.  [ 687403 ] {@source} leaves "}"
  127.  [ 689874 ] is_a is not avaliable in PHP 4.1.0
  128.  [ 689893 ] Warnings on PHP 4.1.0
  129.  [ 689894 ] getincludevalue() missing argument 2 warning
  130.  [ 692522 ] @uses is screwy
  131.  [ 693213 ] tutorials post-processed twice
  132.  [ 693215 ] {@internal}} on single line not working
  133.  [ 694448 ] PKZip has bug, use winzip (not phpDocumentor bug)
  134.  [ 694594 ] PEAR mode: destructor image not shown by phpedit template
  135.  [ 694742 ] PDF converter has no table of contents
  136.  [ 695291 ] link to todo disappears in HTML:Smarty:*
  137.  [ 695482 ] @uses not checking for @access private
  138.  [ 695622 ] HTML:Smarty:* has no package-level docs
  139.  [ 696883 ] <code> in description crashes parser
  140.  [ 697156 ] PHP Warning with PDF Converter
  141.  [ 697656 ] putting a <code> inside a <li> turns it into a literal
  142.  [ 698417 ] {@link element descrip} wrong
  143.  [ 697644 ] parse fails if unmatched html tag, or text outside <li> list
  144.  [ 698468 ] Fatal error when inline tag across two lines
  145.  [ 698356 ] {@internal} not working properly
  146.  [ 701199 ] extra br in @filesource generation
  147.  [ 702549 ] --quiet option not valid?
  148.  [ 705897 ] HTML:frames:earthli misses Page.gif
  149.  [ 708560 ] intelligent list handling isn't quite working
  150.  [ 708559 ] @category tag not really working
  151.  [ 710366 ] <i>-Tag is ignored
  152.  [ 710700 ] empty defaultpackagename = caused busy loop
  153.  [ 711569 ] Fatal Error: Undefined Method during write
  154.  [ 712704 ] HTML:Smarty:* drops class level author information
  155.  [ 708914 ] <var>, <samp>, <kbd> broken
  156.  [ 713201 ] variable variables are not parsed properly in @global
  157.  [ 713954 ] @param type $var when &$var broken
  158.  [ 715077 ] HighlightParser needs @tag object classname support
  159.  [ 715084 ] HighlightParser craps out after $var->
  160.  [ 715452 ] @example doesn't work with anything other than .php
  161.  [ 718253 ] Using 'parent' in @example file causes crash
  162.  
  163. The following bugs are fixed in version 1.2.0BETA3
  164.  [ 661317 ] PDF converter in subpackage ids broken
  165.  [ 669945 ] CHM: "undefined function: convert()" with multiple outputs 
  166.  [ 670205 ] inherited methods have no links
  167.  [ 670341 ] <pre> in docblock doesn't htmlentitie
  168.  [ 670350 ] left_frame.tpl missing package level doc link
  169.  [ 670440 ] Io::getBase() is buggy
  170.  [ 670903 ] inline desc <code> not <pre>-ized
  171.  [ 671620 ] warning in Parser line 2271
  172.  [ 672149 ] @desc broken
  173.  [ 674053 ] Support for require_once 
  174.  [ 674059 ] requires PHP version 4.2 or higher
  175.  [ 674075 ] Bad @param kills parser
  176.  [ 677105 ] unbalanced HTML-comments in output of HTML:frames:phpedit
  177.  [ 677821 ] define not parsed right in highlightparser
  178.  [ 677822 ] {@source} not showing whole source
  179.  [ 677826 ] nonsense @link in @see breaks HTML output
  180.  [ 677938 ] whitespace wrong after certain docblocks
  181.  
  182. The following bugs are fixed in version 1.2.0BETA2
  183.  [ 665707 ] Warnings and errors in new_phpdoc.php
  184.  [ 666307 ] whitespace not ignored in @param
  185.  [ 669132 ] "no @package tag was used" error but @ignore & @package used
  186.  [ 669525 ] {$children[kids].sdesc} contains parent sdesc
  187.  [ 669613 ] Call to undefined function: getclassleft()
  188.  [ 669615 ] methods disapper
  189.  [ 669640 ] javadocdesc broken
  190.  [ 669909 ] PDF text starts off left side of page when have package.html
  191.  
  192. The following bugs are fixed in version 1.2.0BETA1a
  193.  [ 661976 ] @see broken
  194.  [ 662630 ] {} delimited variables within strings mess up the parser
  195.  [ 663435 ] define values, global variable values need htmlentities
  196.  [ 664058 ] @param not displayed in HTMLframesConverter 
  197.  
  198. The following bugs are fixed in version 1.2.0BETA1
  199.  
  200.  [ 586357 ] ignore a directory
  201.  [ 637921 ] sorting is weird with multiple package
  202.  [ 637928 ] multiple converters legal, but fails
  203.  [ 638042 ] two declarations of checkstate()
  204.  [ 638128 ] commandline win32 fails, w/relative path
  205.  [ 639553 ] new_phpdoc.php fails with php 4.2.3
  206.  [ 640507 ] constructor links broken
  207.  [ 641076 ] second instance of loop fails
  208.  [ 641235 ] need trim of -f and -d commandline
  209.  [ 641334 ] parse <script language="php"> as <?php
  210.  [ 642427 ] Incorrect Anchor link from elementIndex
  211.  [ 645588 ] elements named "function.." or "global.." don't link
  212.  [ 646281 ] {@link mailto:e@a descrip} broken
  213.  [ 647494 ] {@link element1, element2} incorrect
  214.  [ 648684 ] links to global vars, defines in Smarty wrong
  215.  [ 649646 ] comments not parsed in function
  216.  [ 649953 ] phpdoc command-line only runs from install dir
  217.  [ 650946 ] link to phpdoc.org new window
  218.  [ 651837 ] getLink broken in rare case
  219.  [ 653627 ] @staticvar broken
  220.  [ 654429 ] tutorial prev/next links not working
  221.  [ 655372 ] smarty template not found in pdf convers
  222.  [ 657041 ] {@source} doesn't work right
  223.  [ 657387 ] parent/child tutorials converted twice
  224.  [ 657726 ] used by link htmlentitiezed
  225.  [ 657739 ] need separate categories of {@tags}
  226.  [ 657934 ] subtrees not processed in Converter
  227.  [ 658120 ] PDF define template has bug
  228.  [ 658121 ] PDF Converter not passing elements sorte
  229.  [ 661316 ] @tutorial tutorial.ext#subsection.section broken
  230.  
  231. There of course were other small bugs fixed, these were just the bugs with 
  232. entries in source forge.  You can view the bug details or reopen it if
  233. you think it's not totally fixed at:
  234. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  235.  
  236. Features added that had Feature Request entries in SF for 1.2.0 rc 2:
  237.  [ 704808 ] command-line switch for template directory/converter directory
  238.  [ 722987 ] Relative example files
  239.  
  240. Features added that had Feature Request entries in SF for 1.2.0 rc 1:
  241.  [ 681470 ] Add syntax highlighting for <programlisting role="php"> 
  242.  [ 682810 ] Xref
  243.  [ 683101 ] starting/ending line numbers of docblocks/classes/methods
  244.  [ 687366 ] phpEdit-style list support
  245.  [ 695621 ] link to section of @filesource from each element
  246.  [ 714025 ] @license tag
  247.  
  248. Features added that had Feature Request entries in SF for 1.2.0 beta 3:
  249.  [ 674470 ] output a list of all @todos
  250.  [ 675194 ] -cp for converter-specific dynamic params 
  251.  
  252. Features added that had Feature Request entries in SF for 1.2.0 beta 2:
  253.  [ 650251 ] @filesource tag 
  254.  [ 670184 ] @example tag 
  255.  [ 670189 ] @internal/{@internal}} 
  256.  [ 670190 ] --ignore-tags command-line 
  257.  
  258. Features added that had Feature Request entries in SF for 1.2.0 beta 1a:
  259.  [ 663436 ] --title available in all pages, html
  260.  [ 663437 ] error if @package is missing 
  261.  [ 663439 ] PEAR command-line switch 
  262.  
  263. Features added that had Feature Request entries in SF for 1.2.0 beta 1:
  264.  
  265.  [ 541896 ] Create an Extended Howto
  266.  [ 558118 ] add {@inheritDoc}
  267.  [ 562604 ] Using @access blocs (_start ... _end)
  268.  [ 564991 ] auto-links to php manual
  269.  [ 566942 ] add {@link seeelement descrip}
  270.  [ 569746 ] make Program_root/ template thing
  271.  [ 577714 ] have master directory option
  272.  [ 586401 ] @access protected
  273.  [ 608603 ] REQUEST:class/function usage information
  274.  [ 615419 ] manuals like "php.net manual"
  275.  [ 623055 ] Zend IDE suport
  276.  [ 634518 ] inherit @author, @version, @copyright
  277.  [ 634589 ] @uses element
  278.  [ 634641 ] A way to document form variables
  279.  [ 635184 ] update all templates to phphtmllib
  280.  [ 637409 ] {keyword} - {data} pairs not flexible
  281.  [ 637660 ] parse type|type
  282.  [ 637920 ] simple way to extend a converter
  283.  [ 642235 ] Index of phphtmllib template
  284.  [ 645775 ] line numbers for elements
  285.  [ 651275 ] tutorials
  286.  [ 651716 ] automatically find README/INSTALL
  287.  [ 651723 ] @tutorial/{@tutorial}
  288.  [ 653608 ] allow the /user ini dir to be configable 
  289.  
  290. ################################################################################
  291.  
  292. The documentation has been updated for this release you can view it at
  293. http://phpdocu.sourceforge.net/spec/
  294. or in the distribution in the spec directory
  295.  
  296. The changelog is available in the tarball, or online at 
  297. http://phpdocu.sourceforge.net/Changelog
  298.  
  299. You can download the newest version from 
  300. http://phpdocu.sourceforge.net/downloads.php
  301.  
  302. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  303. http://phpdoc.org/ 
  304.  
  305. enjoy
  306. -joshua eichorn <jeichorn@phpdoc.org>
  307. -gregory beaver <cellog@users.sourceforge.net>
  308.  
  309.  
  310. vim: set expandtab :
  311.